The ionicons npm package provides a collection of premium icons for use in web, iOS, Android, and desktop apps. These icons are designed to be used with Ionic Framework but can also be used in any web project. The package includes a variety of icons for different purposes such as user interface design, branding, and visual indicators.
Using Ionicons in a Web Project
This code sample demonstrates how to include an Ionicon in your HTML. The 'name' attribute specifies which icon to display.
<ion-icon name="heart"></ion-icon>Styling Ionicons with CSS
This CSS code sets the size and color of all Ionicons in a web page. You can customize the icons further using standard CSS properties.
ion-icon {
font-size: 50px;
color: blue;
}Using Ionicons in JavaScript Frameworks
This code sample shows how to import an Ionicon into a JavaScript framework like Vue or React and use it within the framework's template syntax.
import { heart } from 'ionicons/icons';
<ion-icon :icon="heart"></ion-icon>Font Awesome is a widely used icon set and toolkit that offers a similar range of icons for web development. It has both free and pro versions, and it's comparable to Ionicons in terms of the variety of icons available. However, Font Awesome icons are primarily distributed as a font, whereas Ionicons are available as web components.
Material Icons are Google's icon set designed to work with Material Design components. They offer a different aesthetic compared to Ionicons, which is more in line with Google's Material Design philosophy. Material Icons are also available as a font and can be easily integrated into web projects.
Feather is a collection of simply beautiful open source icons. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency, and readability. Feather provides a more minimalistic and simple design compared to Ionicons, which may be more detailed and varied in design.
Ionicons is a completely open-source icon set with 700+ icons crafted for web, iOS, Android, and desktop apps. Ionicons was built for Ionic Framework, so icons have both Material Design and iOS versions. When used with Ionic, the ion-icon component will automatically use the correct version based on your platform. Additionally, when used outside of Ionic, both ios and md platforms can be chosen by the application.
Note: All brand icons are trademarks of their respective owners. The use of these trademarks does not indicate endorsement of the trademark holder by Drifty, nor vice versa.
Visit ionicons.com and check out the search feature, which has keywords identifying common icon names and styles. For example, if you search for “arrow” we call up every icon that could possibly be used as an arrow.
We intend for this icon pack to be used with Ionic, but it’s by no means limited to it. Use them wherever you see fit, personal or commercial. They are free to use and licensed under MIT.
Thanks for your interest in contributing! Read up on our guidelines for contributing and then look through our issues with a help wanted label.
The Ionicons Web Component is an easy and performant way to use Ionicons in your app. The component will dynamically load an SVG for each icon, so your app is only requesting the icons that you need.
Also note that only visible icons are loaded, and icons which are "below the fold" and hidden from the user's view do not make fetch requests for the svg resource.
If you're using Ionic Framework, Ionicons is packaged by default, so no installation is necessary. Want to use Ionicons without Ionic Framework? Place the following <script> near the end of your page, right before the closing tag, to enable them.
<script src="https://unpkg.com/ionicons@4.2.2/dist/ionicons.js"></script>
To use a built-in icon from the Ionicons package, populate the name attribute on the ion-icon component:
<ion-icon name="heart"></ion-icon>
To use a custom SVG, provide its url in the src attribute to request the external SVG file. The src attribute works the same as <img src="..."> in that the url must be accessible from the webpage that's making a request for the image. Additionally, the external file can only be a valid svg and does not allow scripts or events within the svg element.
<ion-icon src="/path/to/external/file.svg"></ion-icon>
Many icons have both Material Design and iOS versions to provide Platform Continuity for users.
Platform Continuity means that by default, ionicons running on iOS (Apple products such as iPhone and iPad) will display ios styled icons. Alternatively, ionicons running on devices with Material Design theme (commonly seen on Android devices) will see the md styled icons.
Ionic will automatically use the correct version based on the platform. Note that this feature will only automatically kick-in for Ionic apps. When being used outside of an Ionic app, please see the "Outside Ionic App" section below.
To specify the icon for each platform, use the md and ios attributes and provide the platform specific icon name.
<ion-icon ios="ios-heart" md="md-heart"></ion-icon>
When using Ionicons without the Ionic Framework, the icon will default to the Material Design icon style. To specify the non-default icon style, add a platform prefix to the name attribute.
<ion-icon name="ios-heart"></ion-icon>
<ion-icon name="md-heart"></ion-icon>
To specify the icon size, you can use the size attribute for our pre-defined font sizes.
<ion-icon size="small"></ion-icon>
<ion-icon size="large"></ion-icon>
Or you can set a specific size by applying the font-size CSS property on the ion-icon component. It's recommended to use pixel sizes that are a multiple of 8 (8, 16, 32, 64, etc.)
ion-icon {
font-size: 64px;
}
The font icon is compatible with previous versions of Ionicons. If you're using Ionicons for the first time we strongly recommend using the ion-icon web component instead.
An advantage to the font icon file is that all of the icons are in one file. A disadvantage to the font icon file is that all of the icons are in one file. Additionally, large font files have a negative impact on a webpage's time to first paint.
In most cases it may be better to request a small number of svgs using the web component method. A bonus with the web component is that it uses Intersection Observer to only request icons which are viewable by the users (icons above the fold). However, if a webpage has to show many icons at once (such as this website's homepage which is showing 700+ icons on one page), the font icon may be a better choice.
To embed the Ionicons font icon, copy this code into the <head> of the HTML document.
<link href="https://unpkg.com/ionicons@4.2.2/dist/css/ionicons.min.css" rel="stylesheet">
Use the icon index to look up the name of the icon you want to use. The icon's CSS class name will be prefixed with ion-, followed by the platform attribute md-, ios- or logo- and completed wth the icon name.
<i class="ion-md-heart"></i>
<i class="ion-ios-heart"></i>
<i class="ion-md-heart-dislike"></i>
<i class="ion-ios-heart-dislike"></i>
<i class="ion-md-cellular"></i>
<i class="ion-ios-cellular"></i>
<i class="ion-logo-facebook"></i>
<i class="ion-logo-windows"></i>
Ionicons is licensed under the MIT license.
FAQs
Premium icons for Ionic.
The npm package ionicons receives a total of 1,926,169 weekly downloads. As such, ionicons popularity was classified as popular.
We found that ionicons demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."